feat: adds support for OpenAPI 3.2.0 by baywet · Pull Request #65415 · dotnet/aspnetcore

baywet · 2026-02-13T02:43:25Z

fixes #63754
a subsequent pull request(s) will be required to take advantage of the new capabilities like item schema for streaming events

...enApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=schemas-by-ref.verified.txt

Copilot

Pull request overview

This pull request adds support for OpenAPI 3.2.0 by upgrading the Microsoft.OpenApi NuGet packages from version 2.0.0 to 3.3.1 and updating the default OpenAPI specification version from 3.1 to 3.2. The PR makes necessary code adaptations to work with the upgraded library's API changes.

Changes:

Upgrades Microsoft.OpenApi and Microsoft.OpenApi.YamlReader packages from 2.0.0 to 3.3.1
Changes default OpenAPI specification version from OpenApi3_1 to OpenApi3_2
Adapts code to API changes in the library (Dictionary<string, OpenApiMediaType> → Dictionary<string, IOpenApiMediaType>)

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
eng/Versions.props	Updates Microsoft.OpenApi package versions from 2.0.0 to 3.3.1
src/OpenApi/src/Services/OpenApiOptions.cs	Changes default OpenAPI version from OpenApi3_1 to OpenApi3_2
src/OpenApi/src/Services/OpenApiGenerator.cs	Adapts to library API change for Content dictionary types
src/OpenApi/src/Services/OpenApiDocumentService.cs	Adapts to library API change for Content dictionary types
src/OpenApi/gen/XmlCommentGenerator.Emitter.cs	Adds .OfType() filtering when iterating Content values
src/Tools/GetDocumentInsider/src/Commands/GetDocumentCommandWorker.cs	Updates default fallback version to OpenApi3_2
src/Tools/GetDocumentInsider/tests/GetDocumentTests.cs	Updates test assertions to expect OpenApi3_2
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Transformers/CustomSchemaTransformerTests.cs	Adapts test setup to use IOpenApiMediaType dictionary type
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Extensions/OpenApiEndpointRouteBuilderExtensionsTests.cs	Updates version string assertions from "3.1.1" to "3.1.2"
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/snapshots/*.cs	Updates generated code to use .OfType() pattern
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_1/*.txt	Updates version string from "3.1.1" to "3.1.2" in snapshots
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_0/OpenApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=schemas-by-ref.verified.txt	Updates nullable schema structure from library changes
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant.verified.txt	Updates version from "3.1.1" to "3.2.0" for default version

src/OpenApi/src/Services/OpenApiOptions.cs

.../Microsoft.AspNetCore.OpenApi.Tests/Extensions/OpenApiEndpointRouteBuilderExtensionsTests.cs

src/OpenApi/src/Services/OpenApiOptions.cs

Copilot

Pull request overview

Copilot reviewed 35 out of 35 changed files in this pull request and generated 2 comments.

src/Tools/GetDocumentInsider/src/Commands/GetDocumentCommandWorker.cs

src/Tools/GetDocumentInsider/tests/GetDocumentTests.cs

Copilot

Pull request overview

Copilot reviewed 36 out of 36 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 34 out of 34 changed files in this pull request and generated no new comments.

martincostello · 2026-02-13T21:47:22Z

Is the plan to release a preview Swashbuckle.AspNetCore package with support for Microsoft.OpenApi 3.3.1?

For .NET 10 we just had PR builds with prereleases available in MyGet, rather than pushing them to NuGet.org as "official" previews. My aim was to keep the long-lived PR up-to-date as the .NET 11 previews land.

halter73 · 2026-02-13T21:55:58Z

is the only reason why nuget does not complain because aspnet.openapi 10 does not have an upper bound for microsoft.openapi?
If so, could we add one to limit the confusion?

Possibly. I'm normally against upper bounds, because it could be that in certain scenarios, the breakages are irrelevant to the application, but you prevent the developer from upgrading a dependency without scary suppressions. However, if we know for a fact that it's impossible for any application that uses aspnet.openapi 10 to work with microsoft.openapi >= 3, we can consider it.

We wouldn't be able to do that for packages we've already released though. We'd be counting on people updating to the latest 10.x patch before upgrading to 11.

halter73 · 2026-02-13T23:05:44Z

@baywet It looks like some of the Microsoft.AspNetCore.OpenApi.Tests are failing on the CI. Can you look into them? We might just need to regenerate baselines again.

Frulfump · 2026-02-14T02:07:48Z

On second thought, given that the major versions of the Swashbuckle.AspNetCore packages align with the supported ASP.NET Core versions, maybe a new package name is overkill. Hopefully, not too many people will try to use Swashbuckle.AspNetCore 11 with ASP.NET Core 10, but I'm not sure. I certainly wouldn't blame people for thinking it might be okay especially when NuGet does not complain.

I thought that the version alignment was sort of a happy coincidence. It would keep Swashbuckle from introducing breaking changes in of-cycle releases if it needs to be continually aligned with ASP.NET Core?

martincostello · 2026-02-14T08:06:39Z

It is a coincidence, yes.

baywet · 2026-02-17T13:24:26Z

@baywet It looks like some of the Microsoft.AspNetCore.OpenApi.Tests are failing on the CI. Can you look into them? We might just need to regenerate baselines again.

@halter73 I had forgotten one of the files while reverting the default version the other day. We should be good now!

halter73 · 2026-02-17T23:32:56Z

The latest CI run still has a failure in the VerifyOpenApiDocumentIsInvariant test.

baywet · 2026-02-18T01:25:29Z

@halter73 some auto-formatting got in the way, we should be good now

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

…or now. Needs to be reverted before GA. Signed-off-by: Vincent Biret <vibiret@microsoft.com>

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

halter73 · 2026-02-19T20:39:36Z

@baywet @martincostello What do you both think about getting this into preview 2? That should release in less than a month. Or we could wait until Preview 3 in mid-April. I'm fine either way. I'd lean to getting breaking changes out ASAP, but I don't want to rush you.

Edit: I assume getting this out early will be mostly fine given we haven't changed the default spec version.

halter73 · 2026-02-19T20:41:23Z

/backport to release/11.0-preview2

github-actions · 2026-02-19T20:41:33Z

Started backporting to release/11.0-preview2 (link to workflow run)

baywet · 2026-02-19T21:01:31Z

To reiterate what I said on teams for others to read: the earlier the better, it gives more time for our partners to coordinate a release on their end and for us to switch the default version with confidence later on

baywet requested a review from a team as a code owner February 13, 2026 02:43

Copilot AI review requested due to automatic review settings February 13, 2026 02:43

baywet requested review from a team and wtgodbe as code owners February 13, 2026 02:43

github-actions bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Feb 13, 2026

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Feb 13, 2026

Copilot started reviewing on behalf of baywet February 13, 2026 02:44 View session

baywet mentioned this pull request Feb 13, 2026

OpenAPI 3.2.0 just released #63754

Open

1 task

baywet commented Feb 13, 2026

View reviewed changes

...enApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=schemas-by-ref.verified.txt Show resolved Hide resolved

Copilot AI reviewed Feb 13, 2026

View reviewed changes

build-analysis bot mentioned this pull request Feb 13, 2026

Known Build Error: error : Cannot create a file when that file already exists. #61178

Open

martincostello reviewed Feb 13, 2026

View reviewed changes

src/OpenApi/src/Services/OpenApiOptions.cs Outdated Show resolved Hide resolved

baywet mentioned this pull request Feb 13, 2026

fix: validated support for OpenAPI 3.1.2 and updated docs swagger-api/swagger-ui#10726

Merged

baywet requested a review from Copilot February 13, 2026 16:01

Copilot started reviewing on behalf of baywet February 13, 2026 16:02 View session

martincostello added feature-openapi area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Feb 13, 2026

Copilot AI reviewed Feb 13, 2026

View reviewed changes

src/Tools/GetDocumentInsider/src/Commands/GetDocumentCommandWorker.cs Show resolved Hide resolved

src/Tools/GetDocumentInsider/tests/GetDocumentTests.cs Outdated Show resolved Hide resolved

baywet requested a review from Copilot February 13, 2026 16:46

Copilot started reviewing on behalf of baywet February 13, 2026 16:46 View session

Copilot AI reviewed Feb 13, 2026

View reviewed changes

halter73 self-assigned this Feb 13, 2026

baywet requested review from Copilot and halter73 February 13, 2026 19:53

Copilot started reviewing on behalf of baywet February 13, 2026 19:54 View session

This was referenced Feb 13, 2026

slow macOS - "##[error]The job running on agent Azure Pipelines 9 ran longer than the maximum time of 60 minutes." dotnet/dnceng#1883

Open

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

Copilot AI reviewed Feb 13, 2026

View reviewed changes

build-analysis bot mentioned this pull request Feb 13, 2026

[android-arm64] The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#6408

Open

3 tasks

baywet added 9 commits February 18, 2026 09:17

feat: adds support for OpenAPI 3.2.0

5bd53df

tests: fixes failing unit test for generator due to blank spaces

49f0740

feat: makes OpenAPI 3.2.0 the default version

b806fee

tests: adds missing integration tests for version 3.2.0

f7e91f6

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

fix: updates the outdated default version in the message

5560cea

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

tests: aligns test values with error message

e20f14c

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

chore: reverts default versions to 3.1 to avoid breaking swagger UI f…

bc92b8f

…or now. Needs to be reverted before GA. Signed-off-by: Vincent Biret <vibiret@microsoft.com>

tests: reverts version after change in default version

0544318

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

chore: formatting

4999062

baywet force-pushed the feat/oai-3-2-0 branch from 55a4d5f to 4999062 Compare February 18, 2026 14:18

halter73 approved these changes Feb 19, 2026

View reviewed changes

halter73 merged commit 5ad0444 into dotnet:main Feb 19, 2026
12 checks passed

dotnet-policy-service bot added this to the 11.0-preview2 milestone Feb 19, 2026

github-actions bot mentioned this pull request Feb 19, 2026

[release/11.0-preview2] feat: adds support for OpenAPI 3.2.0 #65476

Open

10 tasks

baywet mentioned this pull request Feb 20, 2026

[Feature request]: Plan for aspnet 11 support / OpenAPI 3.2.0 support domaindrivendev/Swashbuckle.AspNetCore#3804

Open

baywet deleted the feat/oai-3-2-0 branch February 20, 2026 14:18

This was referenced Feb 20, 2026

OpenAPI 3.2 Support for Server Sent Events #64379

Open

Open Community (TDC) Meeting, Thursday 19 February 2026 OAI/OpenAPI-Specification#5203

Open

Comments

Conversation

baywet commented Feb 13, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

martincostello commented Feb 13, 2026

Uh oh!

halter73 commented Feb 13, 2026

Uh oh!

halter73 commented Feb 13, 2026

Uh oh!

Frulfump commented Feb 14, 2026

Uh oh!

martincostello commented Feb 14, 2026

Uh oh!

baywet commented Feb 17, 2026

Uh oh!

halter73 commented Feb 17, 2026

Uh oh!

baywet commented Feb 18, 2026

Uh oh!

halter73 commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

halter73 commented Feb 19, 2026

Uh oh!

github-actions bot commented Feb 19, 2026

Uh oh!

baywet commented Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

halter73 commented Feb 19, 2026 •

edited

Loading